var google = require('googleapis');
var compute = google.compute('alpha');

Methods

staticcompute(alpha).compute.addresses.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 61

Retrieves an aggregated list of addresses.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.addresses.delete(params, callback){object}

apis/compute/alpha.js, line 91

Deletes the specified address resource.

Name	Type	Description
params	object	Parameters for request Name Type Description address string Name of the address resource to delete. project string Project ID for this request. region string Name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.addresses.get(params, callback){object}

apis/compute/alpha.js, line 121

Returns the specified address resource.

Name	Type	Description
params	object	Parameters for request Name Type Description address string Name of the address resource to return. project string Project ID for this request. region string Name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.addresses.insert(params, callback){object}

apis/compute/alpha.js, line 151

Creates an address resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. resource compute(alpha).Address Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.addresses.list(params, callback){object}

apis/compute/alpha.js, line 184

Retrieves a list of addresses contained within the specified region.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.addresses.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 215

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.autoscalers.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 251

Retrieves an aggregated list of autoscalers.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.autoscalers.delete(params, callback){object}

apis/compute/alpha.js, line 281

Deletes the specified autoscaler.

Name	Type	Description
params	object	Parameters for request Name Type Description autoscaler string Name of the autoscaler to delete. project string Project ID for this request. zone string Name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.autoscalers.get(params, callback){object}

apis/compute/alpha.js, line 311

Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description autoscaler string Name of the autoscaler to return. project string Project ID for this request. zone string Name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.autoscalers.insert(params, callback){object}

apis/compute/alpha.js, line 341

Creates an autoscaler in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. zone string Name of the zone for this request. resource compute(alpha).Autoscaler Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.autoscalers.list(params, callback){object}

apis/compute/alpha.js, line 374

Retrieves a list of autoscalers contained within the specified zone.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. zone string Name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.autoscalers.patch(params, callback){object}

apis/compute/alpha.js, line 405

Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.

Name	Type	Description
params	object	Parameters for request Name Type Description autoscaler string Name of the autoscaler to update. project string Project ID for this request. zone string Name of the zone for this request. resource compute(alpha).Autoscaler Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.autoscalers.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 436

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. zone string The name of the zone for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.autoscalers.update(params, callback){object}

apis/compute/alpha.js, line 467

Updates an autoscaler in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description autoscaler string optional Name of the autoscaler to update. project string Project ID for this request. zone string Name of the zone for this request. resource compute(alpha).Autoscaler Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendBuckets.delete(params, callback){object}

apis/compute/alpha.js, line 500

Deletes the specified BackendBucket resource.

Name	Type	Description
params	object	Parameters for request Name Type Description backendBucket string Name of the BackendBucket resource to delete. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendBuckets.get(params, callback){object}

apis/compute/alpha.js, line 529

Returns the specified BackendBucket resource. Get a list of available backend buckets by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description backendBucket string Name of the BackendBucket resource to return. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendBuckets.getIamPolicy(params, callback){object}

apis/compute/alpha.js, line 558

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendBuckets.insert(params, callback){object}

apis/compute/alpha.js, line 587

Creates a BackendBucket resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).BackendBucket Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendBuckets.list(params, callback){object}

apis/compute/alpha.js, line 619

Retrieves the list of BackendBucket resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendBuckets.patch(params, callback){object}

apis/compute/alpha.js, line 649

Update the entire content of the BackendBucket resource. This method supports patch semantics.

Name	Type	Description
params	object	Parameters for request Name Type Description backendBucket string Name of the BackendBucket resource to update. project string Project ID for this request. resource compute(alpha).BackendBucket Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendBuckets.setIamPolicy(params, callback){object}

apis/compute/alpha.js, line 679

Sets the access control policy on the specified resource. Replaces any existing policy.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).Policy Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendBuckets.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 709

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendBuckets.update(params, callback){object}

apis/compute/alpha.js, line 739

Update the entire content of the BackendBucket resource.

Name	Type	Description
params	object	Parameters for request Name Type Description backendBucket string Name of the BackendBucket resource to update. project string Project ID for this request. resource compute(alpha).BackendBucket Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendServices.delete(params, callback){object}

apis/compute/alpha.js, line 772

Deletes the specified BackendService resource.

Name	Type	Description
params	object	Parameters for request Name Type Description backendService string Name of the BackendService resource to delete. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendServices.get(params, callback){object}

apis/compute/alpha.js, line 801

Returns the specified BackendService resource. Get a list of available backend services by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description backendService string Name of the BackendService resource to return. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendServices.getHealth(params, callback){object}

apis/compute/alpha.js, line 831

Gets the most recent health check results for this BackendService.

Name	Type	Description
params	object	Parameters for request Name Type Description backendService string Name of the BackendService resource to which the queried instance belongs. project string resource compute(alpha).ResourceGroupReference Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendServices.insert(params, callback){object}

apis/compute/alpha.js, line 860

Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).BackendService Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendServices.list(params, callback){object}

apis/compute/alpha.js, line 892

Retrieves the list of BackendService resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendServices.patch(params, callback){object}

apis/compute/alpha.js, line 922

Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.

Name	Type	Description
params	object	Parameters for request Name Type Description backendService string Name of the BackendService resource to update. project string Project ID for this request. resource compute(alpha).BackendService Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendServices.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 952

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.backendServices.update(params, callback){object}

apis/compute/alpha.js, line 982

Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Name	Type	Description
params	object	Parameters for request Name Type Description backendService string Name of the BackendService resource to update. project string Project ID for this request. resource compute(alpha).BackendService Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.clientSslPolicies.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 1016

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.disks.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 1151

Retrieves an aggregated list of persistent disks.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.disks.createSnapshot(params, callback){object}

apis/compute/alpha.js, line 1183

Creates a snapshot of a specified persistent disk.

Name	Type	Description
params	object	Parameters for request Name Type Description disk string Name of the persistent disk to snapshot. guestFlush boolean optional project string Project ID for this request. zone string The name of the zone for this request. resource compute(alpha).Snapshot Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.disks.delete(params, callback){object}

apis/compute/alpha.js, line 1213

Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

Name	Type	Description
params	object	Parameters for request Name Type Description disk string Name of the persistent disk to delete. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.disks.get(params, callback){object}

apis/compute/alpha.js, line 1243

Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description disk string Name of the persistent disk to return. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.disks.insert(params, callback){object}

apis/compute/alpha.js, line 1274

Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. sourceImage string optional Optional. Source image to restore onto a disk. zone string The name of the zone for this request. resource compute(alpha).Disk Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.disks.list(params, callback){object}

apis/compute/alpha.js, line 1307

Retrieves a list of persistent disks contained within the specified zone.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.disks.resize(params, callback){object}

apis/compute/alpha.js, line 1338

Resizes the specified persistent disk.

Name	Type	Description
params	object	Parameters for request Name Type Description disk string The name of the persistent disk. project string Project ID for this request. zone string The name of the zone for this request. resource compute(alpha).DisksResizeRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.disks.setLabels(params, callback){object}

apis/compute/alpha.js, line 1369

Sets the labels on a disk. To learn more about labels, read the Labeling or Tagging Resources documentation.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. zone string The name of the zone for this request. resource compute(alpha).ZoneSetLabelsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.disks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 1400

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. zone string The name of the zone for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.diskTypes.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 1052

Retrieves an aggregated list of disk types.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.diskTypes.get(params, callback){object}

apis/compute/alpha.js, line 1082

Returns the specified disk type. Get a list of available disk types by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description diskType string Name of the disk type to return. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.diskTypes.list(params, callback){object}

apis/compute/alpha.js, line 1115

Retrieves a list of disk types available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.firewalls.delete(params, callback){object}

apis/compute/alpha.js, line 1433

Deletes the specified firewall.

Name	Type	Description
params	object	Parameters for request Name Type Description firewall string Name of the firewall rule to delete. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.firewalls.get(params, callback){object}

apis/compute/alpha.js, line 1462

Returns the specified firewall.

Name	Type	Description
params	object	Parameters for request Name Type Description firewall string Name of the firewall rule to return. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.firewalls.insert(params, callback){object}

apis/compute/alpha.js, line 1491

Creates a firewall rule in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).Firewall Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.firewalls.list(params, callback){object}

apis/compute/alpha.js, line 1523

Retrieves the list of firewall rules available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.firewalls.patch(params, callback){object}

apis/compute/alpha.js, line 1553

Updates the specified firewall rule with the data included in the request. This method supports patch semantics.

Name	Type	Description
params	object	Parameters for request Name Type Description firewall string Name of the firewall rule to update. project string Project ID for this request. resource compute(alpha).Firewall Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.firewalls.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 1583

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.firewalls.update(params, callback){object}

apis/compute/alpha.js, line 1613

Updates the specified firewall rule with the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description firewall string Name of the firewall rule to update. project string Project ID for this request. resource compute(alpha).Firewall Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.forwardingRules.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 1649

Retrieves an aggregated list of forwarding rules.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.forwardingRules.delete(params, callback){object}

apis/compute/alpha.js, line 1679

Deletes the specified ForwardingRule resource.

Name	Type	Description
params	object	Parameters for request Name Type Description forwardingRule string Name of the ForwardingRule resource to delete. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.forwardingRules.get(params, callback){object}

apis/compute/alpha.js, line 1709

Returns the specified ForwardingRule resource.

Name	Type	Description
params	object	Parameters for request Name Type Description forwardingRule string Name of the ForwardingRule resource to return. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.forwardingRules.insert(params, callback){object}

apis/compute/alpha.js, line 1739

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).ForwardingRule Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.forwardingRules.list(params, callback){object}

apis/compute/alpha.js, line 1772

Retrieves a list of ForwardingRule resources available to the specified project and region.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.forwardingRules.setTarget(params, callback){object}

apis/compute/alpha.js, line 1803

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Name	Type	Description
params	object	Parameters for request Name Type Description forwardingRule string Name of the ForwardingRule resource in which target is to be set. project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).TargetReference Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.forwardingRules.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 1834

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalAddresses.delete(params, callback){object}

apis/compute/alpha.js, line 1867

Deletes the specified address resource.

Name	Type	Description
params	object	Parameters for request Name Type Description address string Name of the address resource to delete. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalAddresses.get(params, callback){object}

apis/compute/alpha.js, line 1896

Returns the specified address resource. Get a list of available addresses by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description address string Name of the address resource to return. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalAddresses.insert(params, callback){object}

apis/compute/alpha.js, line 1925

Creates an address resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).Address Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalAddresses.list(params, callback){object}

apis/compute/alpha.js, line 1957

Retrieves a list of global addresses.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalAddresses.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 1987

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalForwardingRules.delete(params, callback){object}

apis/compute/alpha.js, line 2020

Deletes the specified ForwardingRule resource.

Name	Type	Description
params	object	Parameters for request Name Type Description forwardingRule string Name of the ForwardingRule resource to delete. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalForwardingRules.get(params, callback){object}

apis/compute/alpha.js, line 2049

Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description forwardingRule string Name of the ForwardingRule resource to return. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalForwardingRules.insert(params, callback){object}

apis/compute/alpha.js, line 2078

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).ForwardingRule Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalForwardingRules.list(params, callback){object}

apis/compute/alpha.js, line 2110

Retrieves a list of ForwardingRule resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalForwardingRules.setTarget(params, callback){object}

apis/compute/alpha.js, line 2140

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Name	Type	Description
params	object	Parameters for request Name Type Description forwardingRule string Name of the ForwardingRule resource in which target is to be set. project string Project ID for this request. resource compute(alpha).TargetReference Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalForwardingRules.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 2170

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalOperations.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 2206

Retrieves an aggregated list of all operations.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalOperations.delete(params, callback){object}

apis/compute/alpha.js, line 2235

Deletes the specified Operations resource.

Name	Type	Description
params	object	Parameters for request Name Type Description operation string Name of the Operations resource to delete. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalOperations.get(params, callback){object}

apis/compute/alpha.js, line 2264

Retrieves the specified Operations resource. Get a list of operations by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description operation string Name of the Operations resource to return. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.globalOperations.list(params, callback){object}

apis/compute/alpha.js, line 2296

Retrieves a list of Operation resources contained within the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.healthChecks.delete(params, callback){object}

apis/compute/alpha.js, line 2329

Deletes the specified HealthCheck resource.

Name	Type	Description
params	object	Parameters for request Name Type Description healthCheck string Name of the HealthCheck resource to delete. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.healthChecks.get(params, callback){object}

apis/compute/alpha.js, line 2358

Returns the specified HealthCheck resource. Get a list of available health checks by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description healthCheck string Name of the HealthCheck resource to return. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.healthChecks.insert(params, callback){object}

apis/compute/alpha.js, line 2387

Creates a HealthCheck resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).HealthCheck Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.healthChecks.list(params, callback){object}

apis/compute/alpha.js, line 2419

Retrieves the list of HealthCheck resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.healthChecks.patch(params, callback){object}

apis/compute/alpha.js, line 2449

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

Name	Type	Description
params	object	Parameters for request Name Type Description healthCheck string Name of the HealthCheck resource to update. project string Project ID for this request. resource compute(alpha).HealthCheck Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.healthChecks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 2479

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.healthChecks.update(params, callback){object}

apis/compute/alpha.js, line 2509

Updates a HealthCheck resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description healthCheck string Name of the HealthCheck resource to update. project string Project ID for this request. resource compute(alpha).HealthCheck Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpHealthChecks.delete(params, callback){object}

apis/compute/alpha.js, line 2542

Deletes the specified HttpHealthCheck resource.

Name	Type	Description
params	object	Parameters for request Name Type Description httpHealthCheck string Name of the HttpHealthCheck resource to delete. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpHealthChecks.get(params, callback){object}

apis/compute/alpha.js, line 2571

Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description httpHealthCheck string Name of the HttpHealthCheck resource to return. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpHealthChecks.insert(params, callback){object}

apis/compute/alpha.js, line 2600

Creates a HttpHealthCheck resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).HttpHealthCheck Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpHealthChecks.list(params, callback){object}

apis/compute/alpha.js, line 2632

Retrieves the list of HttpHealthCheck resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpHealthChecks.patch(params, callback){object}

apis/compute/alpha.js, line 2662

Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

Name	Type	Description
params	object	Parameters for request Name Type Description httpHealthCheck string Name of the HttpHealthCheck resource to update. project string Project ID for this request. resource compute(alpha).HttpHealthCheck Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpHealthChecks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 2692

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpHealthChecks.update(params, callback){object}

apis/compute/alpha.js, line 2722

Updates a HttpHealthCheck resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description httpHealthCheck string Name of the HttpHealthCheck resource to update. project string Project ID for this request. resource compute(alpha).HttpHealthCheck Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpsHealthChecks.delete(params, callback){object}

apis/compute/alpha.js, line 2755

Deletes the specified HttpsHealthCheck resource.

Name	Type	Description
params	object	Parameters for request Name Type Description httpsHealthCheck string Name of the HttpsHealthCheck resource to delete. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpsHealthChecks.get(params, callback){object}

apis/compute/alpha.js, line 2784

Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description httpsHealthCheck string Name of the HttpsHealthCheck resource to return. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpsHealthChecks.insert(params, callback){object}

apis/compute/alpha.js, line 2813

Creates a HttpsHealthCheck resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).HttpsHealthCheck Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpsHealthChecks.list(params, callback){object}

apis/compute/alpha.js, line 2845

Retrieves the list of HttpsHealthCheck resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpsHealthChecks.patch(params, callback){object}

apis/compute/alpha.js, line 2875

Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

Name	Type	Description
params	object	Parameters for request Name Type Description httpsHealthCheck string Name of the HttpsHealthCheck resource to update. project string Project ID for this request. resource compute(alpha).HttpsHealthCheck Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpsHealthChecks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 2905

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.httpsHealthChecks.update(params, callback){object}

apis/compute/alpha.js, line 2935

Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description httpsHealthCheck string Name of the HttpsHealthCheck resource to update. project string Project ID for this request. resource compute(alpha).HttpsHealthCheck Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.images.delete(params, callback){object}

apis/compute/alpha.js, line 2968

Deletes the specified image.

Name	Type	Description
params	object	Parameters for request Name Type Description image string Name of the image resource to delete. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.images.deprecate(params, callback){object}

apis/compute/alpha.js, line 2998

Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.

Name	Type	Description
params	object	Parameters for request Name Type Description image string Image name. project string Project ID for this request. resource compute(alpha).DeprecationStatus Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.images.get(params, callback){object}

apis/compute/alpha.js, line 3027

Returns the specified image. Get a list of available images by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description image string Name of the image resource to return. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.images.getFromFamily(params, callback){object}

apis/compute/alpha.js, line 3056

Returns the latest image that is part of an image family and is not deprecated.

Name	Type	Description
params	object	Parameters for request Name Type Description family string Name of the image family to search for. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.images.insert(params, callback){object}

apis/compute/alpha.js, line 3085

Creates an image in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).Image Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.images.list(params, callback){object}

apis/compute/alpha.js, line 3117

Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.images.setLabels(params, callback){object}

apis/compute/alpha.js, line 3147

Sets the labels on an image. To learn more about labels, read the Labeling or Tagging Resources documentation.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).GlobalSetLabelsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.images.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 3177

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.abandonInstances(params, callback){object}

apis/compute/alpha.js, line 3212

Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the managed instance group. project string Project ID for this request. zone string The name of the zone where the managed instance group is located. resource compute(alpha).InstanceGroupManagersAbandonInstancesRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 3244

Retrieves the list of managed instance groups and groups them by zone.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.delete(params, callback){object}

apis/compute/alpha.js, line 3274

Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the managed instance group to delete. project string Project ID for this request. zone string The name of the zone where the managed instance group is located.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.deleteInstances(params, callback){object}

apis/compute/alpha.js, line 3305

Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the managed instance group. project string Project ID for this request. zone string The name of the zone where the managed instance group is located. resource compute(alpha).InstanceGroupManagersDeleteInstancesRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.get(params, callback){object}

apis/compute/alpha.js, line 3335

Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the managed instance group. project string Project ID for this request. zone string The name of the zone where the managed instance group is located.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.insert(params, callback){object}

apis/compute/alpha.js, line 3365

Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. zone string The name of the zone where you want to create the managed instance group. resource compute(alpha).InstanceGroupManager Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.list(params, callback){object}

apis/compute/alpha.js, line 3398

Retrieves a list of managed instance groups that are contained within the specified project and zone.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. zone string The name of the zone where the managed instance group is located.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.listManagedInstances(params, callback){object}

apis/compute/alpha.js, line 3428

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the managed instance group. project string Project ID for this request. zone string The name of the zone where the managed instance group is located.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.patch(params, callback){object}

apis/compute/alpha.js, line 3459

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the instance group manager. project string Project ID for this request. zone string The name of the zone where you want to create the managed instance group. resource compute(alpha).InstanceGroupManager Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.recreateInstances(params, callback){object}

apis/compute/alpha.js, line 3490

Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the managed instance group. project string Project ID for this request. zone string The name of the zone where the managed instance group is located. resource compute(alpha).InstanceGroupManagersRecreateInstancesRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.resize(params, callback){object}

apis/compute/alpha.js, line 3521

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the managed instance group. project string Project ID for this request. size integer The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. zone string The name of the zone where the managed instance group is located.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.resizeAdvanced(params, callback){object}

apis/compute/alpha.js, line 3552

Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the managed instance group. project string Project ID for this request. zone string The name of the zone where the managed instance group is located. resource compute(alpha).InstanceGroupManagersResizeAdvancedRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.setAutoHealingPolicies(params, callback){object}

apis/compute/alpha.js, line 3583

Modifies the autohealing policies.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the instance group manager. project string Project ID for this request. zone string The name of the zone where the managed instance group is located. resource compute(alpha).InstanceGroupManagersSetAutoHealingRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.setInstanceTemplate(params, callback){object}

apis/compute/alpha.js, line 3614

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the managed instance group. project string Project ID for this request. zone string The name of the zone where the managed instance group is located. resource compute(alpha).InstanceGroupManagersSetInstanceTemplateRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.setTargetPools(params, callback){object}

apis/compute/alpha.js, line 3645

Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the managed instance group. project string Project ID for this request. zone string The name of the zone where the managed instance group is located. resource compute(alpha).InstanceGroupManagersSetTargetPoolsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 3676

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. zone string The name of the zone for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroupManagers.update(params, callback){object}

apis/compute/alpha.js, line 3707

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the instance group manager. project string Project ID for this request. zone string The name of the zone where you want to create the managed instance group. resource compute(alpha).InstanceGroupManager Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroups.addInstances(params, callback){object}

apis/compute/alpha.js, line 3742

Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroup string The name of the instance group where you are adding instances. project string Project ID for this request. zone string The name of the zone where the instance group is located. resource compute(alpha).InstanceGroupsAddInstancesRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroups.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 3774

Retrieves the list of instance groups and sorts them by zone.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroups.delete(params, callback){object}

apis/compute/alpha.js, line 3804

Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroup string The name of the instance group to delete. project string Project ID for this request. zone string The name of the zone where the instance group is located.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroups.get(params, callback){object}

apis/compute/alpha.js, line 3834

Returns the specified instance group. Get a list of available instance groups by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroup string The name of the instance group. project string Project ID for this request. zone string The name of the zone where the instance group is located.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroups.insert(params, callback){object}

apis/compute/alpha.js, line 3864

Creates an instance group in the specified project using the parameters that are included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. zone string The name of the zone where you want to create the instance group. resource compute(alpha).InstanceGroup Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroups.list(params, callback){object}

apis/compute/alpha.js, line 3897

Retrieves the list of instance groups that are located in the specified project and zone.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. zone string The name of the zone where the instance group is located.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroups.listInstances(params, callback){object}

apis/compute/alpha.js, line 3932

Lists the instances in the specified instance group.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. instanceGroup string The name of the instance group from which you want to generate a list of included instances. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. zone string The name of the zone where the instance group is located. resource compute(alpha).InstanceGroupsListInstancesRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroups.removeInstances(params, callback){object}

apis/compute/alpha.js, line 3963

Removes one or more instances from the specified instance group, but does not delete those instances.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroup string The name of the instance group where the specified instances will be removed. project string Project ID for this request. zone string The name of the zone where the instance group is located. resource compute(alpha).InstanceGroupsRemoveInstancesRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroups.setNamedPorts(params, callback){object}

apis/compute/alpha.js, line 3994

Sets the named ports for the specified instance group.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroup string The name of the instance group where the named ports are updated. project string Project ID for this request. zone string The name of the zone where the instance group is located. resource compute(alpha).InstanceGroupsSetNamedPortsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceGroups.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 4025

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. zone string The name of the zone for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.addAccessConfig(params, callback){object}

apis/compute/alpha.js, line 4214

Adds an access config to an instance's network interface.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string The instance name for this request. networkInterface string The name of the network interface to add to this instance. project string Project ID for this request. zone string The name of the zone for this request. resource compute(alpha).AccessConfig Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 4246

Retrieves aggregated list of instances.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.attachDisk(params, callback){object}

apis/compute/alpha.js, line 4277

Attaches a Disk resource to an instance.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string The instance name for this request. project string Project ID for this request. zone string The name of the zone for this request. resource compute(alpha).AttachedDisk Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.delete(params, callback){object}

apis/compute/alpha.js, line 4307

Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string Name of the instance resource to delete. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.deleteAccessConfig(params, callback){object}

apis/compute/alpha.js, line 4339

Deletes an access config from an instance's network interface.

Name	Type	Description
params	object	Parameters for request Name Type Description accessConfig string The name of the access config to delete. instance string The instance name for this request. networkInterface string The name of the network interface. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.detachDisk(params, callback){object}

apis/compute/alpha.js, line 4370

Detaches a disk from an instance.

Name	Type	Description
params	object	Parameters for request Name Type Description deviceName string Disk device name to detach. instance string Instance name. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.get(params, callback){object}

apis/compute/alpha.js, line 4400

Returns the specified Instance resource. Get a list of available instances by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string Name of the instance resource to return. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.getIamPolicy(params, callback){object}

apis/compute/alpha.js, line 4430

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.getSerialPortOutput(params, callback){object}

apis/compute/alpha.js, line 4462

Returns the specified instance's serial port output.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string Name of the instance scoping this request. port integer optional Specifies which COM or serial port to retrieve data from. project string Project ID for this request. start string optional For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value that was returned in the previous call. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.insert(params, callback){object}

apis/compute/alpha.js, line 4492

Creates an instance resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. zone string The name of the zone for this request. resource compute(alpha).Instance Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.list(params, callback){object}

apis/compute/alpha.js, line 4525

Retrieves the list of instances contained within the specified zone.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.reset(params, callback){object}

apis/compute/alpha.js, line 4555

Performs a hard reset on the instance.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string Name of the instance scoping this request. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.setDiskAutoDelete(params, callback){object}

apis/compute/alpha.js, line 4587

Sets the auto-delete flag for a disk attached to an instance.

Name	Type	Description
params	object	Parameters for request Name Type Description autoDelete boolean Whether to auto-delete the disk when the instance is deleted. deviceName string The device name of the disk to modify. instance string The instance name. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.setIamPolicy(params, callback){object}

apis/compute/alpha.js, line 4618

Sets the access control policy on the specified resource. Replaces any existing policy.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. zone string The name of the zone for this request. resource compute(alpha).Policy Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.setLabels(params, callback){object}

apis/compute/alpha.js, line 4649

Sets labels on an instance. To learn more about labels, read the Labeling or Tagging Resources documentation.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string Name of the instance scoping this request. project string Project ID for this request. zone string The name of the zone for this request. resource compute(alpha).InstancesSetLabelsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.setMachineType(params, callback){object}

apis/compute/alpha.js, line 4680

Changes the machine type for a stopped instance to the machine type specified in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string Name of the instance scoping this request. project string Project ID for this request. zone string The name of the zone for this request. resource compute(alpha).InstancesSetMachineTypeRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.setMetadata(params, callback){object}

apis/compute/alpha.js, line 4711

Sets metadata for the specified instance to the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string Name of the instance scoping this request. project string Project ID for this request. zone string The name of the zone for this request. resource compute(alpha).Metadata Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.setScheduling(params, callback){object}

apis/compute/alpha.js, line 4742

Sets an instance's scheduling options.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string Instance name. project string Project ID for this request. zone string The name of the zone for this request. resource compute(alpha).Scheduling Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.setServiceAccount(params, callback){object}

apis/compute/alpha.js, line 4773

Sets the service account on the instance.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string Name of the instance resource to start. project string Project ID for this request. zone string The name of the zone for this request. resource compute(alpha).InstancesSetServiceAccountRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.setTags(params, callback){object}

apis/compute/alpha.js, line 4804

Sets tags for the specified instance to the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string Name of the instance scoping this request. project string Project ID for this request. zone string The name of the zone for this request. resource compute(alpha).Tags Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.start(params, callback){object}

apis/compute/alpha.js, line 4834

Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string Name of the instance resource to start. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.startWithEncryptionKey(params, callback){object}

apis/compute/alpha.js, line 4865

Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

Name	Type	Description
params	object	Parameters for request Name Type Description instance string Name of the instance resource to start. project string Project ID for this request. zone string The name of the zone for this request. resource compute(alpha).InstancesStartWithEncryptionKeyRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.stop(params, callback){object}

apis/compute/alpha.js, line 4896

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Name	Type	Description
params	object	Parameters for request Name Type Description discardLocalSsd boolean optional If true, discard the contents of any attached localSSD partitions. Default value is false. instance string Name of the instance resource to stop. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.suspend(params, callback){object}

apis/compute/alpha.js, line 4927

This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.

Name	Type	Description
params	object	Parameters for request Name Type Description discardLocalSsd boolean optional If true, discard the contents of any attached localSSD partitions. Default value is false. instance string Name of the instance resource to suspend. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instances.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 4958

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. zone string The name of the zone for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceTemplates.delete(params, callback){object}

apis/compute/alpha.js, line 4058

Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceTemplate string The name of the instance template to delete. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceTemplates.get(params, callback){object}

apis/compute/alpha.js, line 4087

Returns the specified instance template. Get a list of available instance templates by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceTemplate string The name of the instance template. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceTemplates.insert(params, callback){object}

apis/compute/alpha.js, line 4116

Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).InstanceTemplate Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceTemplates.list(params, callback){object}

apis/compute/alpha.js, line 4148

Retrieves a list of instance templates that are contained within the specified project and zone.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.instanceTemplates.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 4178

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.licenses.get(params, callback){object}

apis/compute/alpha.js, line 4991

Returns the specified License resource. Get a list of available licenses by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description license string Name of the License resource to return. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.machineTypes.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 5027

Retrieves an aggregated list of machine types.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.machineTypes.get(params, callback){object}

apis/compute/alpha.js, line 5057

Returns the specified machine type. Get a list of available machine types by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description machineType string Name of the machine type to return. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.machineTypes.list(params, callback){object}

apis/compute/alpha.js, line 5090

Retrieves a list of machine types available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. zone string The name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.networks.delete(params, callback){object}

apis/compute/alpha.js, line 5123

Deletes the specified network.

Name	Type	Description
params	object	Parameters for request Name Type Description network string Name of the network to delete. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.networks.get(params, callback){object}

apis/compute/alpha.js, line 5152

Returns the specified network. Get a list of available networks by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description network string Name of the network to return. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.networks.insert(params, callback){object}

apis/compute/alpha.js, line 5181

Creates a network in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).Network Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.networks.list(params, callback){object}

apis/compute/alpha.js, line 5213

Retrieves the list of networks available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.networks.switchToCustomMode(params, callback){object}

apis/compute/alpha.js, line 5242

Switches the network mode from auto subnet mode to custom subnet mode.

Name	Type	Description
params	object	Parameters for request Name Type Description network string Name of the network to be updated. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.networks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 5272

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.projects.disableXpnHost(params, callback){object}

apis/compute/alpha.js, line 5304

Disable this project as an XPN host project.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.projects.disableXpnResource(params, callback){object}

apis/compute/alpha.js, line 5333

Disable an XPN resource associated with this host project.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).ProjectsDisableXpnResourceRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.projects.enableXpnHost(params, callback){object}

apis/compute/alpha.js, line 5361

Enable this project as an XPN host project.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.projects.enableXpnResource(params, callback){object}

apis/compute/alpha.js, line 5390

Enable XPN resource (a.k.a service project or service folder in the future) for a host project, so that subnetworks in the host project can be used by instances in the service project or folder.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).ProjectsEnableXpnResourceRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.projects.get(params, callback){object}

apis/compute/alpha.js, line 5418

Returns the specified Project resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.projects.getXpnHost(params, callback){object}

apis/compute/alpha.js, line 5446

Get the XPN host project that this project links to. May be empty if no link exists.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.projects.getXpnResources(params, callback){object}

apis/compute/alpha.js, line 5474

Get XPN resources associated with this host project.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.projects.listXpnHosts(params, callback){object}

apis/compute/alpha.js, line 5503

List all XPN host projects visible to the user in an organization.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).ProjectsListXpnHostsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.projects.moveDisk(params, callback){object}

apis/compute/alpha.js, line 5532

Moves a persistent disk from one zone to another.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).DiskMoveRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.projects.moveInstance(params, callback){object}

apis/compute/alpha.js, line 5561

Moves an instance and its attached persistent disks from one zone to another.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).InstanceMoveRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.projects.setCommonInstanceMetadata(params, callback){object}

apis/compute/alpha.js, line 5590

Sets metadata common to all instances within the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).Metadata Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.projects.setUsageExportBucket(params, callback){object}

apis/compute/alpha.js, line 5619

Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).UsageExportLocation Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionAutoscalers.delete(params, callback){object}

apis/compute/alpha.js, line 5653

Deletes the specified autoscaler.

Name	Type	Description
params	object	Parameters for request Name Type Description autoscaler string Name of the autoscaler to delete. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionAutoscalers.get(params, callback){object}

apis/compute/alpha.js, line 5683

Returns the specified autoscaler.

Name	Type	Description
params	object	Parameters for request Name Type Description autoscaler string Name of the autoscaler to return. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionAutoscalers.insert(params, callback){object}

apis/compute/alpha.js, line 5713

Creates an autoscaler in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).Autoscaler Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionAutoscalers.list(params, callback){object}

apis/compute/alpha.js, line 5746

Retrieves a list of autoscalers contained within the specified region.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionAutoscalers.patch(params, callback){object}

apis/compute/alpha.js, line 5777

Updates a autoscaler in the specified project using the data included in the request. This method supports patch semantics.

Name	Type	Description
params	object	Parameters for request Name Type Description autoscaler string Name of the autoscaler to update. project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).Autoscaler Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionAutoscalers.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 5808

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionAutoscalers.update(params, callback){object}

apis/compute/alpha.js, line 5839

Updates a autoscaler in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description autoscaler string optional Name of the autoscaler to update. project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).Autoscaler Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionBackendServices.delete(params, callback){object}

apis/compute/alpha.js, line 5873

Deletes the specified regional BackendService resource.

Name	Type	Description
params	object	Parameters for request Name Type Description backendService string Name of the BackendService resource to delete. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionBackendServices.get(params, callback){object}

apis/compute/alpha.js, line 5903

Returns the specified regional BackendService resource.

Name	Type	Description
params	object	Parameters for request Name Type Description backendService string Name of the BackendService resource to return. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionBackendServices.getHealth(params, callback){object}

apis/compute/alpha.js, line 5934

Gets the most recent health check results for this regional BackendService.

Name	Type	Description
params	object	Parameters for request Name Type Description backendService string Name of the BackendService resource to which the queried instance belongs. project string region string Name of the region scoping this request. resource compute(alpha).ResourceGroupReference Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionBackendServices.insert(params, callback){object}

apis/compute/alpha.js, line 5964

Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Restrictions and Guidelines for more information.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).BackendService Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionBackendServices.list(params, callback){object}

apis/compute/alpha.js, line 5997

Retrieves the list of regional BackendService resources available to the specified project in the given region.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionBackendServices.patch(params, callback){object}

apis/compute/alpha.js, line 6028

Update the entire content of the regional BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.

Name	Type	Description
params	object	Parameters for request Name Type Description backendService string Name of the BackendService resource to update. project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).BackendService Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionBackendServices.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 6059

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionBackendServices.update(params, callback){object}

apis/compute/alpha.js, line 6090

Update the entire content of the regional BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Name	Type	Description
params	object	Parameters for request Name Type Description backendService string Name of the BackendService resource to update. project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).BackendService Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionDisks.createSnapshot(params, callback){object}

apis/compute/alpha.js, line 6193

Creates a snapshot of this regional disk.

Name	Type	Description
params	object	Parameters for request Name Type Description disk string Name of the regional persistent disk to snapshot. guestFlush boolean optional project string Project ID for this request. region string Name of the region for this request. resource compute(alpha).Snapshot Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionDisks.delete(params, callback){object}

apis/compute/alpha.js, line 6223

Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

Name	Type	Description
params	object	Parameters for request Name Type Description disk string Name of the regional persistent disk to delete. project string Project ID for this request. region string Name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionDisks.get(params, callback){object}

apis/compute/alpha.js, line 6253

Returns a specified regional persistent disk.

Name	Type	Description
params	object	Parameters for request Name Type Description disk string Name of the regional persistent disk to return. project string Project ID for this request. region string Name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionDisks.insert(params, callback){object}

apis/compute/alpha.js, line 6284

Creates a persistent regional disk in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. sourceImage string optional Optional. Source image to restore onto a disk. resource compute(alpha).Disk Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionDisks.list(params, callback){object}

apis/compute/alpha.js, line 6317

Retrieves the list of persistent disks contained within the specified region.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionDisks.resize(params, callback){object}

apis/compute/alpha.js, line 6348

Resizes the specified regional persistent disk.

Name	Type	Description
params	object	Parameters for request Name Type Description disk string Name of the regional persistent disk. project string The project ID for this request. region string Name of the region for this request. resource compute(alpha).RegionDisksResizeRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionDisks.setLabels(params, callback){object}

apis/compute/alpha.js, line 6379

Sets the labels on the target regional disk.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The region for this request. resource_ string Name of the resource for this request. resource compute(alpha).RegionSetLabelsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionDisks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 6410

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionDiskTypes.get(params, callback){object}

apis/compute/alpha.js, line 6124

Returns the specified regional disk type. Get a list of available disk types by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description diskType string Name of the disk type to return. project string Project ID for this request. region string The name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionDiskTypes.list(params, callback){object}

apis/compute/alpha.js, line 6157

Retrieves a list of regional disk types available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string The name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.abandonInstances(params, callback){object}

apis/compute/alpha.js, line 6445

Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string Name of the managed instance group. project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).RegionInstanceGroupManagersAbandonInstancesRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.delete(params, callback){object}

apis/compute/alpha.js, line 6475

Deletes the specified managed instance group and all of the instances in that group.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string Name of the managed instance group to delete. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.deleteInstances(params, callback){object}

apis/compute/alpha.js, line 6506

Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string Name of the managed instance group. project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).RegionInstanceGroupManagersDeleteInstancesRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.get(params, callback){object}

apis/compute/alpha.js, line 6536

Returns all of the details for the specified managed instance group.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string Name of the managed instance group to return. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.insert(params, callback){object}

apis/compute/alpha.js, line 6566

Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).InstanceGroupManager Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.list(params, callback){object}

apis/compute/alpha.js, line 6599

Retrieves the list of managed instance groups that are contained within the specified region.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.listManagedInstances(params, callback){object}

apis/compute/alpha.js, line 6629

Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the managed instance group. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.recreateInstances(params, callback){object}

apis/compute/alpha.js, line 6660

Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string Name of the managed instance group. project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).RegionInstanceGroupManagersRecreateRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.resize(params, callback){object}

apis/compute/alpha.js, line 6691

Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string Name of the managed instance group. project string Project ID for this request. region string Name of the region scoping this request. size integer Number of instances that should exist in this instance group manager.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.setAutoHealingPolicies(params, callback){object}

apis/compute/alpha.js, line 6722

Modifies the autohealing policy for the instances in this managed instance group.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string Name of the managed instance group. project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).RegionInstanceGroupManagersSetAutoHealingRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.setInstanceTemplate(params, callback){object}

apis/compute/alpha.js, line 6753

Sets the instance template to use when creating new instances in this group. Existing instances are not affected.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string The name of the managed instance group. project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).RegionInstanceGroupManagersSetTemplateRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.setTargetPools(params, callback){object}

apis/compute/alpha.js, line 6784

Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroupManager string Name of the managed instance group. project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).RegionInstanceGroupManagersSetTargetPoolsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroupManagers.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 6815

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroups.get(params, callback){object}

apis/compute/alpha.js, line 6849

Returns the specified instance group resource.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroup string Name of the instance group resource to return. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroups.list(params, callback){object}

apis/compute/alpha.js, line 6882

Retrieves the list of instance group resources contained within the specified region.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroups.listInstances(params, callback){object}

apis/compute/alpha.js, line 6917

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. instanceGroup string Name of the regional instance group for which we want to list the instances. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).RegionInstanceGroupsListInstancesRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroups.setNamedPorts(params, callback){object}

apis/compute/alpha.js, line 6948

Sets the named ports for the specified regional instance group.

Name	Type	Description
params	object	Parameters for request Name Type Description instanceGroup string The name of the regional instance group where the named ports are updated. project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).RegionInstanceGroupsSetNamedPortsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionInstanceGroups.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 6979

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionOperations.delete(params, callback){object}

apis/compute/alpha.js, line 7013

Deletes the specified region-specific Operations resource.

Name	Type	Description
params	object	Parameters for request Name Type Description operation string Name of the Operations resource to delete. project string Project ID for this request. region string Name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionOperations.get(params, callback){object}

apis/compute/alpha.js, line 7043

Retrieves the specified region-specific Operations resource.

Name	Type	Description
params	object	Parameters for request Name Type Description operation string Name of the Operations resource to return. project string Project ID for this request. region string Name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regionOperations.list(params, callback){object}

apis/compute/alpha.js, line 7076

Retrieves a list of Operation resources contained within the specified region.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regions.get(params, callback){object}

apis/compute/alpha.js, line 7109

Returns the specified Region resource. Get a list of available regions by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region resource to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.regions.list(params, callback){object}

apis/compute/alpha.js, line 7141

Retrieves the list of region resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routers.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 7177

Retrieves an aggregated list of routers.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routers.delete(params, callback){object}

apis/compute/alpha.js, line 7207

Deletes the specified Router resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. router string Name of the Router resource to delete.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routers.get(params, callback){object}

apis/compute/alpha.js, line 7237

Returns the specified Router resource. Get a list of available routers by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. router string Name of the Router resource to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routers.getRouterStatus(params, callback){object}

apis/compute/alpha.js, line 7267

Retrieves runtime information of the specified router.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. router string Name of the Router resource to query.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routers.insert(params, callback){object}

apis/compute/alpha.js, line 7297

Creates a Router resource in the specified project and region using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. resource compute(alpha).Router Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routers.list(params, callback){object}

apis/compute/alpha.js, line 7330

Retrieves a list of Router resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routers.patch(params, callback){object}

apis/compute/alpha.js, line 7361

Updates the entire content of the Router resource. This method supports patch semantics.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. router string Name of the Router resource to update. resource compute(alpha).Router Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routers.preview(params, callback){object}

apis/compute/alpha.js, line 7392

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. router string Name of the Router resource to query. resource compute(alpha).Router Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routers.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 7423

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routers.update(params, callback){object}

apis/compute/alpha.js, line 7454

Updates the entire content of the Router resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. router string Name of the Router resource to update. resource compute(alpha).Router Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routes.delete(params, callback){object}

apis/compute/alpha.js, line 7487

Deletes the specified Route resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. route string Name of the Route resource to delete.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routes.get(params, callback){object}

apis/compute/alpha.js, line 7516

Returns the specified Route resource. Get a list of available routes by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. route string Name of the Route resource to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routes.insert(params, callback){object}

apis/compute/alpha.js, line 7545

Creates a Route resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).Route Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routes.list(params, callback){object}

apis/compute/alpha.js, line 7577

Retrieves the list of Route resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.routes.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 7607

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.snapshots.delete(params, callback){object}

apis/compute/alpha.js, line 7640

Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snaphots.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. snapshot string Name of the Snapshot resource to delete.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.snapshots.get(params, callback){object}

apis/compute/alpha.js, line 7669

Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. snapshot string Name of the Snapshot resource to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.snapshots.list(params, callback){object}

apis/compute/alpha.js, line 7701

Retrieves the list of Snapshot resources contained within the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.snapshots.setLabels(params, callback){object}

apis/compute/alpha.js, line 7731

Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).GlobalSetLabelsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.snapshots.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 7761

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.sslCertificates.delete(params, callback){object}

apis/compute/alpha.js, line 7794

Deletes the specified SslCertificate resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. sslCertificate string Name of the SslCertificate resource to delete.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.sslCertificates.get(params, callback){object}

apis/compute/alpha.js, line 7823

Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. sslCertificate string Name of the SslCertificate resource to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.sslCertificates.insert(params, callback){object}

apis/compute/alpha.js, line 7852

Creates a SslCertificate resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).SslCertificate Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.sslCertificates.list(params, callback){object}

apis/compute/alpha.js, line 7884

Retrieves the list of SslCertificate resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.sslCertificates.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 7914

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.subnetworks.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 7950

Retrieves an aggregated list of subnetworks.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.subnetworks.delete(params, callback){object}

apis/compute/alpha.js, line 7980

Deletes the specified subnetwork.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. subnetwork string Name of the Subnetwork resource to delete.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.subnetworks.expandIpCidrRange(params, callback){object}

apis/compute/alpha.js, line 8011

Expands the IP CIDR range of the subnetwork to a specified value.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. subnetwork string Name of the Subnetwork resource to update. resource compute(alpha).SubnetworksExpandIpCidrRangeRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.subnetworks.get(params, callback){object}

apis/compute/alpha.js, line 8041

Returns the specified subnetwork. Get a list of available subnetworks list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. subnetwork string Name of the Subnetwork resource to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.subnetworks.getIamPolicy(params, callback){object}

apis/compute/alpha.js, line 8071

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.subnetworks.insert(params, callback){object}

apis/compute/alpha.js, line 8101

Creates a subnetwork in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).Subnetwork Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.subnetworks.list(params, callback){object}

apis/compute/alpha.js, line 8134

Retrieves a list of subnetworks available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.subnetworks.setIamPolicy(params, callback){object}

apis/compute/alpha.js, line 8165

Sets the access control policy on the specified resource. Replaces any existing policy.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request. resource compute(alpha).Policy Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.subnetworks.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 8196

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetHttpProxies.delete(params, callback){object}

apis/compute/alpha.js, line 8229

Deletes the specified TargetHttpProxy resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetHttpProxy string Name of the TargetHttpProxy resource to delete.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetHttpProxies.get(params, callback){object}

apis/compute/alpha.js, line 8258

Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetHttpProxy string Name of the TargetHttpProxy resource to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetHttpProxies.insert(params, callback){object}

apis/compute/alpha.js, line 8287

Creates a TargetHttpProxy resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).TargetHttpProxy Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetHttpProxies.list(params, callback){object}

apis/compute/alpha.js, line 8319

Retrieves the list of TargetHttpProxy resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetHttpProxies.setUrlMap(params, callback){object}

apis/compute/alpha.js, line 8349

Changes the URL map for TargetHttpProxy.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetHttpProxy string Name of the TargetHttpProxy to set a URL map for. resource compute(alpha).UrlMapReference Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetHttpProxies.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 8379

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetHttpsProxies.delete(params, callback){object}

apis/compute/alpha.js, line 8412

Deletes the specified TargetHttpsProxy resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetHttpsProxy string Name of the TargetHttpsProxy resource to delete.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetHttpsProxies.get(params, callback){object}

apis/compute/alpha.js, line 8441

Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetHttpsProxy string Name of the TargetHttpsProxy resource to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetHttpsProxies.insert(params, callback){object}

apis/compute/alpha.js, line 8470

Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).TargetHttpsProxy Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetHttpsProxies.list(params, callback){object}

apis/compute/alpha.js, line 8502

Retrieves the list of TargetHttpsProxy resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetHttpsProxies.setSslCertificates(params, callback){object}

apis/compute/alpha.js, line 8532

Replaces SslCertificates for TargetHttpsProxy.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetHttpsProxy string Name of the TargetHttpsProxy resource to set an SslCertificates resource for. resource compute(alpha).TargetHttpsProxiesSetSslCertificatesRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetHttpsProxies.setUrlMap(params, callback){object}

apis/compute/alpha.js, line 8562

Changes the URL map for TargetHttpsProxy.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetHttpsProxy string Name of the TargetHttpsProxy resource whose URL map is to be set. resource compute(alpha).UrlMapReference Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetHttpsProxies.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 8592

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetInstances.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 8628

Retrieves an aggregated list of target instances.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetInstances.delete(params, callback){object}

apis/compute/alpha.js, line 8658

Deletes the specified TargetInstance resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetInstance string Name of the TargetInstance resource to delete. zone string Name of the zone scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetInstances.get(params, callback){object}

apis/compute/alpha.js, line 8688

Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetInstance string Name of the TargetInstance resource to return. zone string Name of the zone scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetInstances.insert(params, callback){object}

apis/compute/alpha.js, line 8718

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. zone string Name of the zone scoping this request. resource compute(alpha).TargetInstance Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetInstances.list(params, callback){object}

apis/compute/alpha.js, line 8751

Retrieves a list of TargetInstance resources available to the specified project and zone.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. zone string Name of the zone scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetInstances.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 8782

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. zone string The name of the zone for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetPools.addHealthCheck(params, callback){object}

apis/compute/alpha.js, line 8817

Adds health check URLs to a target pool.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. targetPool string Name of the target pool to add a health check to. resource compute(alpha).TargetPoolsAddHealthCheckRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetPools.addInstance(params, callback){object}

apis/compute/alpha.js, line 8848

Adds an instance to a target pool.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. targetPool string Name of the TargetPool resource to add instances to. resource compute(alpha).TargetPoolsAddInstanceRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetPools.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 8880

Retrieves an aggregated list of target pools.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetPools.delete(params, callback){object}

apis/compute/alpha.js, line 8910

Deletes the specified target pool.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. targetPool string Name of the TargetPool resource to delete.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetPools.get(params, callback){object}

apis/compute/alpha.js, line 8940

Returns the specified target pool. Get a list of available target pools by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. targetPool string Name of the TargetPool resource to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetPools.getHealth(params, callback){object}

apis/compute/alpha.js, line 8971

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. targetPool string Name of the TargetPool resource to which the queried instance belongs. resource compute(alpha).InstanceReference Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetPools.insert(params, callback){object}

apis/compute/alpha.js, line 9001

Creates a target pool in the specified project and region using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. resource compute(alpha).TargetPool Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetPools.list(params, callback){object}

apis/compute/alpha.js, line 9034

Retrieves a list of target pools available to the specified project and region.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region scoping this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetPools.removeHealthCheck(params, callback){object}

apis/compute/alpha.js, line 9065

Removes health check URL from a target pool.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. targetPool string Name of the target pool to remove health checks from. resource compute(alpha).TargetPoolsRemoveHealthCheckRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetPools.removeInstance(params, callback){object}

apis/compute/alpha.js, line 9096

Removes instance URL from a target pool.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region scoping this request. targetPool string Name of the TargetPool resource to remove instances from. resource compute(alpha).TargetPoolsRemoveInstanceRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetPools.setBackup(params, callback){object}

apis/compute/alpha.js, line 9128

Changes a backup target pool's configurations.

Name	Type	Description
params	object	Parameters for request Name Type Description failoverRatio number optional New failoverRatio value for the target pool. project string Project ID for this request. region string Name of the region scoping this request. targetPool string Name of the TargetPool resource to set a backup pool for. resource compute(alpha).TargetReference Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetPools.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 9159

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetSslProxies.delete(params, callback){object}

apis/compute/alpha.js, line 9192

Deletes the specified TargetSslProxy resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetSslProxy string Name of the TargetSslProxy resource to delete.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetSslProxies.get(params, callback){object}

apis/compute/alpha.js, line 9221

Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetSslProxy string Name of the TargetSslProxy resource to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetSslProxies.insert(params, callback){object}

apis/compute/alpha.js, line 9250

Creates a TargetSslProxy resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).TargetSslProxy Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetSslProxies.list(params, callback){object}

apis/compute/alpha.js, line 9282

Retrieves the list of TargetSslProxy resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetSslProxies.setBackendService(params, callback){object}

apis/compute/alpha.js, line 9312

Changes the BackendService for TargetSslProxy.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetSslProxy string Name of the TargetSslProxy resource whose BackendService resource is to be set. resource compute(alpha).TargetSslProxiesSetBackendServiceRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetSslProxies.setProxyHeader(params, callback){object}

apis/compute/alpha.js, line 9342

Changes the ProxyHeaderType for TargetSslProxy.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetSslProxy string Name of the TargetSslProxy resource whose ProxyHeader is to be set. resource compute(alpha).TargetSslProxiesSetProxyHeaderRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetSslProxies.setSslCertificates(params, callback){object}

apis/compute/alpha.js, line 9372

Changes SslCertificates for TargetSslProxy.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. targetSslProxy string Name of the TargetSslProxy resource whose SslCertificate resource is to be set. resource compute(alpha).TargetSslProxiesSetSslCertificatesRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetSslProxies.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 9402

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetVpnGateways.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 9438

Retrieves an aggregated list of target VPN gateways.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetVpnGateways.delete(params, callback){object}

apis/compute/alpha.js, line 9468

Deletes the specified target VPN gateway.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. targetVpnGateway string Name of the target VPN gateway to delete.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetVpnGateways.get(params, callback){object}

apis/compute/alpha.js, line 9498

Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. targetVpnGateway string Name of the target VPN gateway to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetVpnGateways.insert(params, callback){object}

apis/compute/alpha.js, line 9528

Creates a target VPN gateway in the specified project and region using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. resource compute(alpha).TargetVpnGateway Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetVpnGateways.list(params, callback){object}

apis/compute/alpha.js, line 9561

Retrieves a list of target VPN gateways available to the specified project and region.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.targetVpnGateways.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 9592

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.urlMaps.delete(params, callback){object}

apis/compute/alpha.js, line 9625

Deletes the specified UrlMap resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. urlMap string Name of the UrlMap resource to delete.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.urlMaps.get(params, callback){object}

apis/compute/alpha.js, line 9654

Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. urlMap string Name of the UrlMap resource to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.urlMaps.insert(params, callback){object}

apis/compute/alpha.js, line 9683

Creates a UrlMap resource in the specified project using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource compute(alpha).UrlMap Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.urlMaps.invalidateCache(params, callback){object}

apis/compute/alpha.js, line 9713

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. urlMap string Name of the UrlMap scoping this request. resource compute(alpha).CacheInvalidationRule Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.urlMaps.list(params, callback){object}

apis/compute/alpha.js, line 9745

Retrieves the list of UrlMap resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.urlMaps.patch(params, callback){object}

apis/compute/alpha.js, line 9775

Updates the entire content of the UrlMap resource. This method supports patch semantics.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. urlMap string Name of the UrlMap resource to update. resource compute(alpha).UrlMap Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.urlMaps.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 9805

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.urlMaps.update(params, callback){object}

apis/compute/alpha.js, line 9835

Updates the entire content of the UrlMap resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. urlMap string Name of the UrlMap resource to update. resource compute(alpha).UrlMap Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.urlMaps.validate(params, callback){object}

apis/compute/alpha.js, line 9865

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. urlMap string Name of the UrlMap resource to be validated as. resource compute(alpha).UrlMapsValidateRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.vpnTunnels.aggregatedList(params, callback){object}

apis/compute/alpha.js, line 9901

Retrieves an aggregated list of VPN tunnels.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.vpnTunnels.delete(params, callback){object}

apis/compute/alpha.js, line 9931

Deletes the specified VpnTunnel resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. vpnTunnel string Name of the VpnTunnel resource to delete.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.vpnTunnels.get(params, callback){object}

apis/compute/alpha.js, line 9961

Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. vpnTunnel string Name of the VpnTunnel resource to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.vpnTunnels.insert(params, callback){object}

apis/compute/alpha.js, line 9991

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string Name of the region for this request. resource compute(alpha).VpnTunnel Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.vpnTunnels.list(params, callback){object}

apis/compute/alpha.js, line 10024

Retrieves a list of VpnTunnel resources contained in the specified project and region.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. region string Name of the region for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.vpnTunnels.testIamPermissions(params, callback){object}

apis/compute/alpha.js, line 10055

Returns permissions that a caller has on the specified resource.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. region string The name of the region for this request. resource_ string Name of the resource for this request. resource compute(alpha).TestPermissionsRequest Request body data
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.zoneOperations.delete(params, callback){object}

apis/compute/alpha.js, line 10089

Deletes the specified zone-specific Operations resource.

Name	Type	Description
params	object	Parameters for request Name Type Description operation string Name of the Operations resource to delete. project string Project ID for this request. zone string Name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.zoneOperations.get(params, callback){object}

apis/compute/alpha.js, line 10119

Retrieves the specified zone-specific Operations resource.

Name	Type	Description
params	object	Parameters for request Name Type Description operation string Name of the Operations resource to return. project string Project ID for this request. zone string Name of the zone for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.zoneOperations.list(params, callback){object}

apis/compute/alpha.js, line 10152

Retrieves a list of Operation resources contained within the specified zone.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request. zone string Name of the zone for request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.zones.get(params, callback){object}

apis/compute/alpha.js, line 10185

Returns the specified Zone resource. Get a list of available zones by making a list() request.

Name	Type	Description
params	object	Parameters for request Name Type Description project string Project ID for this request. zone string Name of the zone resource to return.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object

staticcompute(alpha).compute.zones.list(params, callback){object}

apis/compute/alpha.js, line 10217

Retrieves the list of Zone resources available to the specified project.

Name	Type	Description
params	object	Parameters for request Name Type Description filter string optional Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. maxResults integer optional The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. orderBy string optional Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. pageToken string optional Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. project string Project ID for this request.
callback	callback	The callback that handles the response.

Returns:

Type	Description
object	Request object